home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / tex / utter10.zip / UTTER.DOC < prev    next >
Text File  |  1994-06-20  |  6KB  |  127 lines
  1. Files included with UTTER10.ZIP:
  2.  
  3.    UTTER.EXE - executable
  4.    UTTER.DAT - default data file containing quotes
  5.    UTTER.PAS - Turbo Pascal 6.0 source code
  6.    UTTER.DOC - this file
  7.  
  8.  
  9. This file (UTTER.DOC) is not essential for the execution of UTTER.EXE; it is
  10. merely the output (for the most part) from executing UTTER as follows:
  11.   UTTER /V? > UTTER.DOC
  12.  
  13.  
  14. Installation Instructions
  15. =========================
  16. - UTTER is best used within your AUTOEXEC.BAT file; thus, upon start-up, a
  17.   quote will be displayed. My AUTOEXEC.BAT file has the following:
  18.      C:\UTILS\UTTER.EXE /WMK
  19.   This updates the default data file UTTER.DAT automatically if it requires
  20.   updating, displays a quote, then prompts the user to press a key or click
  21.   a mouse button to continue.
  22.  
  23. - UTTER requires an ASCII data file which contains the quotes to display.
  24.   By default this is called UTTER.DAT; however, this can be over-ridden by
  25.   specifying a different file on the command-line.
  26.  
  27. - When UTTER is first executed it will create an index file called UTTER.IDX.
  28.   Every data file requires an index file located in the same directory as
  29.   its data file.
  30.  
  31.  
  32. UTTER 1.0, Copyright (c) 1994, Jody R. Cairns
  33.  
  34. Syntax: UTTER  [option(s)]  [datafile path]
  35.  
  36. Options: /N ----------- show Number of quotes in data file
  37.          /R ----------- display Random quote
  38.          /U ----------- Update index file
  39.          /W ----------- disable all Warning prompts
  40.          /B ----------- use BIOS routines for video output (slower)
  41.          /V ----------- use DOS routines for Video output (slowest)
  42.          /S ----------- enable video Snow-checking (for CGA monitors)
  43.          /K ----------- prompt user to press Key after quote is displayed
  44.          /M ----------- prompt user to click Mouse after quote is displayed
  45.          /P[x] -------- Pause for approximately x seconds after quote
  46.                         (default is 2 seconds. Max. is 60.)
  47.          /E[editor] --- invoke Editor (EDIT is default)
  48.          /?, /H ------- for more information
  49.  
  50. - UTTER displays a quote from an ASCII text data file, called UTTER.DAT
  51.   by default, which is assumed to be in the same directory as UTTER.EXE. 
  52.  
  53. - All quotes in the data file must end with a tilde (~); and the length
  54.   of each quote is unlimited, as is the size of the data file.
  55.  
  56. - To use a different data file just specify its full path name on the command-
  57.   line. If the default data file is in a different directory than the
  58.   executable file, then specify the directory name on the command-line,
  59.   making sure it ends with a "\" character.
  60.  
  61. - An index file is associated with each different data file, having the
  62.   same name as the data file except with an .IDX extension.
  63.  
  64. - Each index file must be in the same directory as its corresponding data
  65.   file. Index files are created automatically if they do not exist in the
  66.   same directory as its data file or if they are corrupt in some way.
  67.  
  68. - Options can appear in any order and can be combined.
  69.  
  70.  Explanation of options (examples follow)
  71.  ======================
  72.    /N  --------- displays the number of quotes in the current data file.
  73.    /R  --------- display a random quote from the current data file.
  74.    /U  --------- updates current data file, creating an index file for it.
  75.    /W  --------- disables any warning prompts when creating index file.
  76.    /B  --------- by default, UTTER outputs directly to video memory. This
  77.                  option enables BIOS output routines, which is slower.
  78.    /V  --------- use DOS routines for output. This is the slowest but it
  79.                  allows any output to be redirected, if desired.
  80.    /S  --------- enables snow-checking, which CGA screens may require.
  81.    /K  --------- after a quote is displayed, the user is prompted with the
  82.                  following: "Press any key to continue...".
  83.    /M  --------- after a quote is displayed, the user is prompted with the
  84.                  following: "Click mouse button to continue...". If the /K
  85.                  option is enabled in addition to this one, the prompt is:
  86.                  "Press any key or click mouse button to continue...".
  87.    /P[x]  ------ after a quote is displayed, UTTER pauses for the specified
  88.                  number of seconds, or for 2 seconds by default. Seconds must
  89.                  be >= 0 and <= 60. If x is specified, no other options can
  90.                  immediatedly follow x. Ex: "/P3V" -> wrong, "/P3 /V" -> right.
  91.    /E[editor]  - executes, by default, the editor EDIT using either the default
  92.                  data file UTTER.DAT or the file specified on the command-line.
  93.                  To use a different editor, specify the editor's name
  94.                  immediately after the /E option.
  95.  
  96.  Examples
  97.  ========
  98. 1) UTTER  quotes.txt  /vr  /k
  99.    - displays a random quote from the file QUOTES.TXT using DOS output
  100.      routines and prompts user to press a key afterwards.
  101.  
  102. 2) UTTER  /wu  /eMyEdit
  103.    - executes the editor MYEDIT on the default data file UTTER.DAT, then
  104.      updates the index file automatically after MYEDIT execution halts.
  105.  
  106. 3) UTTER  /sp5  \utils\  /r
  107.    - displays a random quote from the default data file UTTER.DAT located in
  108.      the \UTILS\ directory using snow-checking, pausing for five seconds
  109.      afterwards.
  110.  
  111.  Copyright Information
  112.  =====================
  113. - UTTER may be distributed freely in the public domain, although donations
  114.   would be most appreciated.
  115.  
  116. - I take no responsibility for any liability, loss, or damage caused or
  117.   alleged to be caused directly or indirectly from the use of this program.
  118.  
  119. - UTTER was written in Turbo Pascal 6.0. Source code is available upon request.
  120.   Future versions are forthcoming.
  121.  
  122. - If you discover any bugs, or have any ideas or suggestions, please feel
  123.   free to contact me:  Jody R. Cairns
  124.                        P.O. Box 5991
  125.                        St. John's, NFLD.
  126.                        Canada  A1C 5X4
  127.                        e-mail: jodyc@cs.mun.ca